home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / nws_231.zip / NWSFLASH.DOC < prev    next >
Text File  |  1991-02-08  |  16KB  |  335 lines
  1.  
  2.    ┌───────────────────────────────────────────────────────────────────────┐
  3.   ╒═════════════════════════════════════════════════════════════════════════╕
  4.   │▒▒                                                                     ▒▒│
  5.   │▒▒ ───────────────────────── N W S F L A S H ───────────────────────── ▒▒│
  6.   │▒▒                 The NewsFlash Generator for QuickBBS                ▒▒│
  7.   │▒▒                                                                     ▒▒│
  8.   ╘═════════════════════════════════════════════════════════════════════════╛
  9.    └───────────────────────────────────────────────────────────────────────┘
  10.  
  11.                             Written by M.Jay Benton
  12.                           Benton Software Enterprises
  13.  
  14.                     Dedicated to someone special, A.L.Schack
  15.  
  16.                                  Version 2.31
  17.  
  18.  
  19. Original Release:   Version 1.00, November  1989
  20.  
  21.  
  22. Introduction ────────────────────────────────────────────────────────────────
  23.    NewsFlash was created to tend to the need of having the news
  24.    bulletins automatically timed according to events taking place on a
  25.    QuickBBS System. NewsFlash allows the sysop to specify a time frame
  26.    that individual story is to be included in the ASCII or ANSI
  27.    screens displayed by QuickBBS.
  28.  
  29. Disclaimer ──────────────────────────────────────────────────────────────────
  30.    The author of this product only guarntees that the product will
  31.    take up space on your drives. There is no warrantee associated with
  32.    this product.   In simple terms, you use it, you take the risk.
  33.  
  34. Files in Distribution File (ZIP) ────────────────────────────────────────────
  35.  
  36.     NWSFLASH.DOC --- This documentation file.
  37.     NWSFLASH.EXE --- NWSFLASH executable.
  38.     NWSFLASH.CTL --- Example Control File.
  39.     NWSTODAY.EXE --- 'In History' interface to NWSFLASH.
  40.     FLASHES.F01  --- Example FORCED News Story.
  41.     FLASHES.S01  --- Example STOPPABLE News Story.
  42.     FLASHES.S00  --- Example of NWSTODAY output, NewsFlash Interface.
  43.     TODAY.ASC ------ Example of NWSTODAY output, QuickBBS displayable.
  44.     NEWS.ANS ------- Sample of NEWS files generated by Mayhem Unlimited.
  45.     NEWS.ASC ------/
  46.     VIEW.EXE ------- View ANSI/ASCII files like QuickBBS/RA.
  47.  
  48.  
  49.  ***  The example files always contain the latest file limits and  ***
  50.  ***  formats.   It is always suggested to read them just to make  ***
  51.  ***  sure that the formats and limits have not changed.  I might  ***
  52.  ***  change the limits or the formats and forget to make the      ***
  53.  ***  changes in the documentation.                                ***
  54.  
  55.  
  56.  
  57. Installation ────────────────────────────────────────────────────────────────
  58.    NewsFlash is best suited for usage by placing it into a directory of
  59.    it's own. In it's own directory, you would not have to worry about
  60.    reading files from other software that might use the same name
  61.    files and all of the files are in one place, making maintenance
  62.    simplier.
  63.  
  64.    Place all of the files found in the distribution file into the
  65.    directory you wish to have NewsFlash running from.
  66.  
  67.    ┌───────────────────────────────────────────────────────────────┐
  68.    │░▒ You will have to switch to that directory before running  ▒░│
  69.    │░▒ NWSFLASH because it does not go looking for files outside ▒░│
  70.    │░▒ of the current directory.                                 ▒░│
  71.    └───────────────────────────────────────────────────────────────┘
  72.  
  73.    Load NWSFLASH.CTL, FLASHES.F01, and FLASHES.S01 into your
  74.    favorite ASCII-Text editor (like Q-Edit).
  75.  
  76.    The format for the NWSFLASH.CTL is as follows:
  77.       Line-1 :  BBS Name
  78.       Line-2 :  Sysop Name
  79.       Line-3 :  Registeration Code  (1 if not registered)
  80.       Line-4 :  News Flash Screen Name
  81.       Line-5 :  News Flash Screen Name, Line #2. Blank if not used.
  82.       Line-6 :  Line#1 of No News Message
  83.       Line-7 :  Line#2 of No News Message. Blank if not used.
  84.       Line-8 :  ASCII File & Path Name (NEWS.ASC)
  85.       Line-9 :  ANSI File & Path Name  (NEWS.ANS)
  86.       Line-10:  Color Codes for -- Tractor Feeds
  87.       Line-11:  Color Codes for -- NWSFLASH Title
  88.       Line-12:  Color Codes for -- News Story Titles
  89.       Line-13:  Color Codes for -- Story Authors
  90.       Line-14:  Color Codes for -- News Story Body
  91.       Line-15:  Color Codes for -- Press <ENTER> Message
  92.       Line-16:  Color Codes for -- Boldfacing Attribute
  93.       Line-17:  Color Codes for -- Reverse Video Attribute
  94.  
  95.    Limits for Control File:
  96.       Line-1 : 70-Characters, Any ASCII Characters.
  97.       Line-2 : 70-Characters, Any ASCII Characters.
  98.       Line-3 : Valid registration number or 1.
  99.       Line-4 : 70-Characters, Any ASCII Characters.
  100.       Line-5 : 70-Characters, Any ASCII Characters.
  101.       Line-6 : 70-Characters, Any ASCII Characters.
  102.       Line-7 : 70-Characters, Any ASCII Characters.
  103.       Line-8 : 76-Characters containing valid DOS File Names & Paths.
  104.       Line-9 : 76-Characters containing valid DOS File Names & Paths.
  105.       Line-10 thru 17: Color Codes, codes selected from ANSI Code Chart
  106.                at the end of this document.
  107.                FORMAT:  #;##;##m
  108.                         |  |  |
  109.                         |  |  \----  BackGround Color Code
  110.                         |  \-------  ForeGround Color Code
  111.                         \----------  Attribute Code
  112.  
  113.  
  114.     ░▒ Notes on Color Codes: NWSFLASH uses standard ANSI.SYS color ▒░
  115.     ░▒ codes and cursor control codes. You can find a copy of the  ▒░
  116.     ░▒ color combination codes at the end of this document.        ▒░
  117.  
  118.  
  119.    The format for FLASHES.F##:
  120.       Line-1 :  News Story Title
  121.       Line-2 :  Story Author Name
  122.       Line-3 :  Start Date for Including into display
  123.       Line-4 :  End Date for Including into display
  124.       Line-5 :  Delete Story File after Expiration (Y/N)
  125.       Line-6 :  Date to be converted to FLASHES.S## file.
  126.       Line-7 :  Body of Story
  127.       Line-??:  Body of Story
  128.  
  129.    The format for FLASHES.S##:
  130.       Line-1 :  News Story Title
  131.       Line-2 :  Story Author Name
  132.       Line-3 :  Start Date for Including into display
  133.       Line-4 :  End Date for Including into display
  134.       Line-5 :  Delete Story File after Expiration (Y/N)
  135.       Line-6 :  Date to be converted to FLASHES.F## file.
  136.       Line-7 :  Body of Story
  137.       Line-??:  Body of Story
  138.  
  139.     Limits for FLASHES.F## & FLASHES.S##:
  140.   Story Titles:  70-Characters, Any ASCII Characters.
  141.   Author Name:   70-Characters, Any ASCII Characters.
  142.   Start Date:    YYYYMMDD  (Example: 19900101 for January 1, 1990)
  143.   End Date:      YYYYMMDD  (Example: 19900130 for January 30, 1990)
  144.   Convert Date:  YYYYMMDD  (Example: 19900115 for January 15, 1990)
  145.   Story Lines:   70-Characters, remembering that NWSFLASH automatically
  146.                  centers the text.
  147.  
  148.   Notes on conversion dates:
  149.       When the original story is FORCED or STOPPABLE, the conversion date
  150.       is set by the author of the story.
  151.  
  152.       When STOPPABLE story is converted to a forced, the new conversion
  153.       date is system date plus 10-days. The new StartDate is the system
  154.       date.
  155.  
  156.              FORCED -- > Stoppable w/ 00000000 convert date.
  157.              STOPPABLE --> FORCED w/ systemdate + 10days convert date
  158.                    -- > STOPPABLE w/ 00000000 convert date.
  159.  
  160.       The formats of the FLASHES.x## allow you to create a stoppable story
  161.       that can be converted to a forced. After 10-days, the forced story
  162.       will be converted back to a stoppable. The new stoppable will contain
  163.       a conversion date of 00000000 to never be reconverted.
  164.  
  165.   All you have to do now is to execute NWSFLASH. It uses some windowing
  166.   functions to display what is doing as it processes the FLASHES.
  167.  
  168.   When NWSFLASH terminates, it will tell you how many stories it
  169.   included in the generation of the NEWS.A?? files.
  170.  
  171.  
  172. Dynamic Dates ───────────────────────────────────────────────────────────────
  173.     In the FLASHES.X## files, you can specify a year and a certain day
  174.     without specifying a month. Replace the month with 00 and every
  175.     month, the story will be included in the NEWS.A?? generation. This
  176.     is great to automatically remind people of monthly meetings, os
  177.     monthly system events. For example, the start date of a story
  178.     could be 19900001 and the ending date could be 19900010. This
  179.     range would be from the 1st of each month to the 10th of each
  180.     month. When NWSFLASH runs, it would replace the month (00) with the
  181.     current system month.... Nifty idea, huh ??
  182.  
  183.  
  184. Miscellaneous Notes ─────────────────────────────────────────────────────────
  185.     1).  You are limited to 99 stories for the F## files and 99
  186.          for the S## files.
  187.     2).  The Start-Date and End-Date ranges allow you to specify the
  188.          time range that the particular story is to be displayed to
  189.          users in the Display-Files (NEWS.ASC / NEWS.ANS).
  190.     3).  The major difference between F## & S## files, aside from the
  191.          extension, is the F## files are forced -- the user HAS TO
  192.          read them. The S## files are breakable using the <S>-key like
  193.          many of QuickBBS' screens.
  194.     4).  NWSFLASH reads the directory and retrieves the files in the
  195.          same order that you would see them when you issue the DIR
  196.          command at the DOS prompt. So, sort them into the particular
  197.          order you want them displayed before running NWSFLASH.
  198.     5).  The Advanced-Graphics Feature allows some fancy paging in the
  199.          NEWS.ANS file. Run with this option and signon to your
  200.          QuickBBS System locally and see what I mean. It would be a
  201.          lot easier for you to see it than for me to try to describe
  202.          it.
  203.  
  204. NwsToday ────────────────────────────────────────────────────────────────────
  205.     This program will create two files when executed. The first is a plain
  206.     ASCII file (TODAY.ASC) that can be readily displayed by QuickBBS. The
  207.     second file is a Flashes story, FLASHES.X00. By specifying <S> on the
  208.     command line (NWSTODAY S), NWSTODAY will create FLASHES.S00 and set the
  209.     Delete-After-Expire to <Y> and no conversion date. On the other hand,
  210.     if you specify <F> on the command line (NWSTODAY F), NWSTODAY will
  211.     create FLASHES.F00 and set the Delete-After-Expire to <Y> with no
  212.     conversion date. NwsToday will only work with Version 2.30a or better
  213.     of NWSFLASH. It is highly recommended that NWSTODAY be run right before
  214.     NWSFLASH is executed.
  215.  
  216.     This program uses data files that are used by the program called
  217.     TODAY.EXE as written by Patrick Kincaid. TODAY.EXE & related files can
  218.     be requested from Mayhem Unlimited as TODAY.ZIP. At this point in time,
  219.     I am not sure what version he has available for distribution.
  220.  
  221. Closing ─────────────────────────────────────────────────────────────────────
  222.     Well.... That's all I can think of to tell you. NWSFLASH was
  223.     written to provide flexibility and some power in controlling the
  224.     contents of the NEWS.A?? files.  I have several FLASHES.S## files
  225.     already created to wish people Merry Christmas, Happy Thanksgiving
  226.     and a couple of other holidays. It's great for month reminders by
  227.     using the dynamic-date features.
  228.  
  229.    If you have any ideas or comments, please feel free to contact me
  230.    by using one of the means listed below in "Registeration".
  231.  
  232.    Bye for now....
  233.  
  234.                         M.Jay Benton
  235.  
  236.  
  237.  
  238.  
  239.  
  240. Registeration ───────────────────────────────────────────────────────────────
  241.  
  242.      Although I do not require any formal registration,you are required to
  243.      register NWSFLASH. You may contact me via one of the methods listed below
  244.      to obtain a valid registration code number that is entered into the
  245.      control file.
  246.  
  247.         $$ DONATIONS ARE ACCEPTED AND WILL NOT BE REFUSED $$
  248.  
  249.         After all, that's what pays for the computer, electricity,
  250.         phone line, repairs, and the compilers.
  251.  
  252.         After the initial release of NWSFLASH, there has been several
  253.         registrations, no donations. My expenses are adding up to maintain
  254.         this software and my system to support and develop it.
  255.  
  256.      Registered Sysops notify me of the their usage of NWSFLASH will be
  257.      notified, if feasibly possible, when there is an update of NWSFLASH.
  258.      Donations will not be refused and are welcomed... probably more than
  259.      you would realize.
  260.  
  261.      By not registering NWSFLASH, you will not be able to take advantage of
  262.      the conversion from forced to stoppable flashes. This feature will not
  263.      work without a valid registration number.
  264.  
  265.      You can notify me at the following locations:
  266.  
  267.          FidoNet:
  268.                Mayhem Unlimited  1:150/290   (302)678-0141 (Fastest)
  269.                Terry's Board     1:150/215   (302)739-3670
  270.                Andromeda BBS     1:150/211   (302)284-3178
  271.  
  272.          USPostal:   Jay Benton
  273.                      C/O CU-BBS
  274.                         P.O.Box 1626
  275.                         Dover, De 19903-1626
  276.  
  277.                      (Enclose a self address/self-stamped envelope
  278.                       for registeration code. This is the slowest method
  279.                       because of my current time schedules.)
  280.  
  281.       Please include the EXACT SPELLING of your BBS's name, your name,
  282.       and which version of NWSFLASH you are using.
  283.       I have to have the name of your BBS, exactly as it will appear in the
  284.       control file...
  285.  
  286.       If you chose to register via FidoNet, poll 1:150/290 after about a
  287.       week if you wish to send the information through the net. I will
  288.       not allow my system to call other systems that operate below
  289.       9600-baud... Sorry...
  290.  
  291.  
  292. Upgrades ────────────────────────────────────────────────────────────────────
  293.       Since NWSFLASH relies upon QuickBBS, when there is a change in QuickBBS,
  294.       chances are very high that there would be a new version of NWSFLASH. The
  295.       only thing that NWSFLASH relies upon is the screen control codes.
  296.  
  297. Suggestions/Comments ────────────────────────────────────────────────────────
  298.       Like with any of my software, suggestions and your comments are
  299.       welcome. If you discover a possible error, please contact me as
  300.       soon as possible.
  301.  
  302.  
  303.  
  304.  
  305. Copyrights ──────────────────────────────────────────────────────────────────
  306.     NWSFLASH is copyrighted by M.Jay Benton.
  307.     TODAY was written by Patrick Kincaid,
  308.                          618 Douglas Drive,
  309.                          Mill Valley, CA 94941.
  310.     QuickBBS was developed by Alan Hudson, owned and modified by
  311.              the QuickBBS Group, Inc, and who knows who now...
  312.  
  313.  
  314. *********************************************************************
  315.                    ANSI COLOR CODES
  316.  
  317.   Attribute Code    ------Action-------
  318.       0............ All Off
  319.       2............ High-Intensity
  320.       4............ Underline (MONOCHROME
  321.       5............ Blink On
  322.       7............ Reverse Video
  323.       8............ Invisible
  324.  
  325.   --Color Name-- --ForeGround Code--  --BackGround Code--
  326.     Black....... ........30...................40.........
  327.     Red......... ........31...................41.........
  328.     Green....... ........32...................42.........
  329.     Yellow...... ........33...................43.........
  330.     Blue........ ........34...................44.........
  331.     Magenta..... ........35...................45.........
  332.     Cyan........ ........36...................46.........
  333.     White....... ........37...................47.........
  334. *********************************************************************
  335.